Retrieve List Item

This AgileShape can be used to retrieve list item field values to be updated in a custom attribute, schema metadata, or SharePoint metadata.

NOTE: If errors occur during the execution, a message will be written into the SharePoint Integration log file.

NOTE: This AgileShape is a specialized sub-type of the AgilePart AgileShape. Refer to the documentation for the AgilePart AgileShape for additional information about the properties and behavior that this sub-type inherits from the AgilePart AgileShape.

Design-Time Properties

NOTE: Since this AgileShape is a specialized sub-type of the AgilePart AgileShape, all of the standard properties supported by the AgilePart AgileShape are also supported by this AgileShape. Since they are already documented elsewhere, the standard AgilePart properties are not documented in this section. Refer to the documentation for the AgilePart AgileShape for information about the standard AgilePart properties. Additional design-time properties (other than the standard AgilePart properties) that are specific to this AgileShape are documented below.

ItemValues

Specifies the configuration for retrieving list item field values and where the values will be updated in a custom attribute, schema metadata, or SharePoint metadata. 

List URL

Specifies the SharePoint list URL that includes the list item fields to be retrieved. A valid list URL is required, if a library URL (such as document library URL or form library URL) instead of a list URL is used, an error will occur during execution. Below are examples of a valid list URL:

• http://Machine_Name:port/sites/SiteName/ListName
• ${DocUrl}

ListItem Field Name

Read Only

The list item identifier field.

ListItem Field Value

Specifies the list item ID such as:

• ${ListItemID} or ${SubListItemID}

• list item ID

After the Source Site is configured, the configuration window will look similar to below.

The MetaData Name column is used to specify a custom attribute, schema metadata, or SharePoint metadata where the value from the list field that is retrieved will be updated to.

NOTE: In order to update schema metadata with the retrieved field values, the AgilePoint Envision process template type must be either Microsoft InfoPath or Generic.

The MetaData Name can be configured as follows:

1. Use the Add button to select a SharePoint metadata item.
2. Input a custom attribute name (e.g. Company1).
3. Click the button at the right side of the field to select a schema metadata.

ListItemFieldName

Read Only

The list item identifier field.

ListItemFieldValue

Read Only

The list item ID.

ListURL 

Read Only

The SharePoint list URL that includes the list item fields to be retrieved.